home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / DEVELOP.ZIP / ACCOUNT.DOC < prev    next >
Text File  |  1995-03-13  |  6KB  |  96 lines
  1. The following information covers the file format used by the account tracking
  2. file (both .DBF and .TXT formats) which PCBoard uses to track user activities
  3. and the debits and credits associated with them.
  4.  
  5.  
  6.    "Account Tracking File" - This file is used to track the user's activities
  7.    on your system and the charges (and reimbursements) that are made.  When
  8.    you define the name for this file you are also instructing PCBoard as to
  9.    how it should create the file.  For instance, if you name it TRACKING.DBF
  10.    then PCBoard will write to it in DBF format.  Any file extension other than
  11.    .DBF will be treated as an ASCII text file.
  12.  
  13.    NOTE:  The Account Tracking File can be SHARED among all of your nodes by
  14.    pointing to the same physical file in all of your node configurations.
  15.    PCBoard will properly append each new record to the end of that file.
  16.    However, due to the frequency of the updates, you may want to have each node
  17.    post to its own file just to make the updates quicker.  Either way works
  18.    fine, the latter approach, however, may create a little extra work for you
  19.    in having to analyze and/or combine the files when billing your customers.
  20.  
  21.    As a dBase file, the following fields are defined:
  22.  
  23.       Field Name  Type  Len  Dec  Description
  24.       ==========  ====  ===  ===  ===========
  25.       Date        'D'     8       Date when the activity occured
  26.       Time        'C'     5       Time when the activity occured
  27.       Name        'C'    25       The name of the user performing the activity
  28.       NodeNumber  'N'     5   0   The node number on which the activity worked
  29.       ConfNumber  'N'     5   0   The conference the caller was in at the time
  30.       Activity    'C'    15       Text abbreviation of the activity
  31.       SubAct      'C'    25       Filenames, etc.  See below.
  32.       UnitCost    'N'    14   4   Per-Unit cost (per minute, per byte, etc)
  33.       Quantity    'N'     9   0   Number of units (minutes, bytes, etc)
  34.       Value       'N'    14   4   Total cost or payback (UnitCost * Quantity)
  35.  
  36.    The Activity values, used by PCBoard, are as follows:
  37.  
  38.       Activity        Sub-Activity          Explanation of Value
  39.       ==============  ====================  ==================================
  40.       CMD USAGE       Name of the Command   Cost for this usage of the command
  41.       CMD USAGE MIN   Name of the Command   Cost for the minutes it was used
  42.       DOOR USAGE      Name of the DOOR      Cost for this usage of the door
  43.       DOOR USAGE MIN  Name of the DOOR      Cost for the minutes it was used
  44.       MSG READ                              Cost to read messages
  45.       MSG READ CAP                          Cost to download captured messages
  46.       MSG READ CAP    "CREDIT"              Credits on an aborted capture D/L
  47.       MSG WRITE       TO: name              Cost to write public message
  48.       MSG WRITE PRIV  TO: name              Cost to write private message
  49.       MSG WRITE ECHO  TO: name              Cost to write echoed message
  50.       DNLD FILE       File name downloaded  Cost to download the file
  51.       DNLD BYTES      File name downloaded  Cost to download the file
  52.       UPLD FILE       File name uploaded    Cost/reward to upload the file
  53.       UPLD BYTES      File name uploaded    Cost/reward to upload the file
  54.       UPLD FILE FAIL  File name uploaded    Backing out charge/reward for upld
  55.       UPLD BYTES FAIL File name uploaded    Backing out charge/reward for upld
  56.       CHAT TIME                             Cost for min spent in Group Chat
  57.       CONF TIME                             Cost for min spent in conference
  58.       TIME ONLINE                           Cost for minutes spent online
  59.       TIME ONLINE     PEAK                  Cost for time spent during peak
  60.       LOGON           LOCAL or BPS rate     Cost for logging onto the system
  61.  
  62.    All values are positive if they are to be subtracted from the balance,
  63.    negative if they are to be added into the balance.  In other words, if you
  64.    reward your callers for uploads, then they will show up as negative values
  65.    in the account tracking file.
  66.  
  67.    NOTE: Additional activities, subactivities, and charges may be posted via
  68.    programs written in PPL.
  69.  
  70.    The ASCII text version of the account tracking file is identical to the
  71.    above as far as content is concerned.  The layout is one record per line,
  72.    with all fields, except the last one, padded to their full length.  The
  73.    format, then, looks like this:
  74.  
  75.      Date       8 characters, left justified
  76.                 1 character - separator
  77.      Time       5 characters, left justified
  78.                 1 character - separator
  79.      Name      25 characters, left justified
  80.                 1 character - separator
  81.      NodeNum    5 characters, right justified, padded on left with spaces
  82.                 1 character - separator
  83.      ConfNum    5 characters, right justified, padded on left with spaces
  84.                 1 character - separator
  85.      Activity  15 characters, left justified
  86.                 1 character - separator
  87.      SubAct    25 characters, left justified
  88.                 1 character - separator
  89.      UnitCost  14 characters, right justified with 4 decimal places
  90.                 1 character - separator
  91.      Quantity   9 characters, right justified
  92.                 1 character - separator
  93.      Value     14 characters, right justified, with 4 decimal places
  94.                 2 characters - CR/LF
  95.  
  96.